Hoàn Tiền Giao Dịch
Đường dẫn
- URL:
/api/v1/transaction/refund - Method:
POST - Mô tả: API cho phép tạo yêu cầu hoàn tiền cho giao dịch
Request
Bảng Request
| Tham số | Kiểu dữ liệu + Độ dài | Bắt buộc | Mô tả |
|---|---|---|---|
| request_id | string(50) | Có | Mã ID request duy nhất, định dạng đề xuất: MerchantCode+YYYYMMDDHHMMSS+UniqueId |
| request_time | string(19) | Có | Thời gian request theo định dạng: YYYY-MM-DD HH:MM:SS |
| merchant_code | string(20) | Có | Merchant code được cung cấp bởi Baokim trước khi tích hợp |
| sub_merchant_code | string(50) | Có | Nếu Seller nằm dưới sub-merchant của bạn, điền mã sub merchant được cung cấp bởi Baokim. Nếu Seller nằm dưới bạn, điền Merchant_code được cung cấp bởi Baokim ở trên |
| seller_id | string(50) | Có | Mã Seller khớp với Onboarding Sellers API |
| refunded_transaction_id | string(50) | Có | Điền TransactionID của Baokim mà merchant muốn hoàn tiền |
| refund_reference_id | string(50) | Có | Mã tham chiếu của hoàn tiền được quản lý trong hệ thống của bạn. Mã này là duy nhất. |
| refund_type | int(1) | Có | 1: Hoàn tiền toàn bộ, 2: Hoàn tiền một phần. Mặc định = 1 |
| amount | decimal(12,2) | Có | Số tiền của đơn hàng |
| fee_payer | int(1) | Có | 1: Merchant, 2: User. Mặc định = 1 |
| reason | string(255) | Có | Lý do hoàn tiền |
Ví dụ Request
{
"request_id": "MERCHANT12345678901234510281",
"request_time": "2024-11-15 14:36:00",
"merchant_code": "PHUONGTT",
"sub_merchant_code": "SUBPHUONGTT",
"seller_id": "SELLER12345678901234510281",
"refunded_transaction_id": "1234567892",
"refund_reference_id": "TT1234567890",
"amount": "1000000.00",
"refund_type": 1,
"fee_payer": 1,
"reason": "Customer requested a refund"
}
Response
Bảng Response
| Tham số | Kiểu dữ liệu + Độ dài | Bắt buộc | Mô tả |
|---|---|---|---|
| response_code | int(4) | Có | Mã lỗi từ Baokim theo Bảng Mã Lỗi |
| response_message | string(100) | Có | Mô tả mã lỗi từ Baokim theo Bảng Mã Lỗi |
| data | object | Có | Dữ liệu của phản hồi |
| data.merchant_code | string(20) | Có | Merchant code được cung cấp bởi Baokim trước khi tích hợp |
| data.sub_merchant_code | string(20) | Có | Mã sub merchant được cung cấp bởi Baokim trước khi tích hợp |
| data.refund_reference_id | string(50) | Có | Mã tham chiếu của hoàn tiền được quản lý trong hệ thống của bạn. Mã này là duy nhất |
| data.refund_transaction_id | string(50) | Có | Mã giao dịch hoàn tiền từ Baokim |
| data.refunded_transaction_id | string(50) | Có | TransactionID của Baokim mà merchant muốn hoàn tiền |
| data.refund_status | int(1) | Có | Trạng thái hoàn tiền. 1. Thành công, 2. Thất bại, 3. Đang xử lý |
| data.refund_type | int(1) | Có | 1: Hoàn tiền toàn bộ, 2: Hoàn tiền một phần. Mặc định = 1 |
| data.request_amount | decimal(12,2) | Có | Số tiền yêu cầu |
| data.refund_fee | decimal(12,2) | Có | Phí hoàn tiền |
| data.fee_payer | int(1) | Có | 1: Merchant, 2: User. Mặc định = 1 |
| data.refund_amount | decimal(12,2) | Có | Số tiền hoàn tiền |
| data.reason | string(255) | Có | Lý do hoàn tiền |
Ví dụ Response
{
"response_code": 200,
"response_message": "Success",
"data": {
"merchant_code": "PHUONGTT",
"sub_merchant_code": "SUBPHUONGTT",
"seller_id": "SELLER12345678901234510281",
"refund_reference_id" : "TT1234567890",
"refund_transaction_id": "1234567893",
"refunded_transaction_id": "1234567892",
"refund_status": 1,
"refund_type": 1,
"refund_amount": "1000000.00",
"request_amount": "1000000.00",
"fee_payer": 1,
"refund_fee": "0.00",
"reason": "Customer requested a refund"
}
}
Mã Lỗi
| Mã Response | Thông báo Response |
|---|---|
| 200 | Success |
| 99 | Pending |
| 11 | Failed |
| 101 | System Error |
| 110 | Merchant code invalid |
| 120 | Invalid signature |
| 422 | Validation Error |